Apple DocViewer is an online documentation application. It provides a standard way for Apple to distribute documentation to developers in an electronic form.
Apple DocViewer provides a quick on-screen reference for browsing through multiple documents. It supports full Macintosh mixed-text and graphics, printing, interactive table of contents/catalog, book indexes, text search & retrieval, the ability to copy text and/or pictures for use in other applications, and provides the ability to set bookmarks to commonly used pages in documentation.
Version 1.0 Release Notes
Since Release 1.0a12, Apple DocViewer has gone through a few feature enhancements and major bug fixes. The following list outlines the major changes in Version 1.0:
- Dynamic text reformatting in Text View: When you change the window size in Text View, the text automatically rewraps in the window according to the new window size.
- Personal style sheet for Text View: Apple DocViewer lets you change font/style/size for Chapter/Section headings and body text in Text View.
- More intuitive Print Dialog
- Even/Odd page printing capability
- Arrow keys for navigation and selection in text
- Improved memory usage via caching
- Balloon help for menu items
- Remembering “Page Setup” information
- Removal of low-memory crash bugs
- Consistent error messages and disabling of commands during low-memory conditions
There are some minor bugs and enhancements which are not addressed in Version 1.0. These and user tips are documented in later pages of this Read Me file. If you have comments or suggestions we would like to hear from you via AppleLink to DEV.CD. We will not be answering individual questions about this software, but this information will be forwarded to the engineering group.
Installation
Apple DocViewer runs on all models of the Macintosh® computer from the Macintosh Plus onward. It runs under versions 6.0.5 and later of the Macintosh system software, including version 7.0, Release 7.1. Apple DocViewer requires at least 1024 Kb memory partition.
Apple DocViewer also requires both bitmap and TrueType fonts. In particular, many Apple DocViewer documents use Palatino, Helvetica, Courier, and Zapf Dingbats. We are providing these fonts in the Apple DocViewer Fonts folder.
The Apple DocViewer application can be run directly off a CD, or from a server, but we strongly recommend that you copy the application to your local hard drive.
Limitations
Apple DocViewer is NOT a word processor—it was designed to support quick conversion of existing technical documents to electronic form. Apple DocViewer focuses on being both a printing and display tool. Printing is limited by Apple DocViewer’s display capabilities and displaying is limited by Apple DocViewer’s print capabilities. In particular:
- Display spacing may appear uneven on some documents because the text is kerned for printing, not display.
- Output on non-postscript printers may be less satisfactory.
- Color/Gray Scale must be selected for printing color/shaded figures.
- Documents may be more difficult to read on systems which do not have a complete set of screen fonts or do not have TrueType installed.
This version of Apple DocViewer has a number of features that are incomplete, notably:
- The “Text Only” view is only partially implemented. Text still needs to continuously flow between page boundaries for true dynamic text reformatting capabilities.
- Printing from the Finder is not supported.
Recommendations, Tips, and Techniques
• It is not required, but use both bitmap and TrueType fonts for the best display quality . If you are running under System 6, please use the TrueType INIT in the TrueType Fonts & Software folder.
• To improve display legibility on monitors larger than 13'' (that typically have a resolution greater then 72 dpi) set SCALING to 112% in the document window. We've found this to be a good compromise between window size and font size.
• Apple DocViewer has been optimized for displaying documents off of a CD-ROM or AppleShare server. However, copying the document file you use most (and its associated index file) to your local hard disk can significantly improve performance.
• The “Query” command uses an efficient indexing technique with Apple DocViewer documents, however, it does not index every word. The “Find” command uses a search method that is much slower, but will find every word in a document. The “Catalog” window’s “Filter” narrows the list of catalog entries. The “Open Book Index” displays an index created by the authors of the document. Explore the difference between these four features and use the one most appropriate for your task.
• Apple DocViewer is optimized for printing on Postscript printers, such as the Apple LaserWriter. New Inside Macintosh documents take advantage of the “Larger Print Area” option available from the LaserWriter’s Page Setup/Options dialogue. Printing with other printers will work, but there may be clipped pages, or reduced print quality.
• Users in countries which use A4 paper may print Apple DocViewer documents by using the “Reduce or Enlarge” setting of the “Page Setup” dialog.
• Apple DocViewer does not provide the functionality to modify any document; instead it saves your personal information on bound documents in its preference file . If you want to pass along bookmarks to other people, give them a copy of your Apple DocViewer.Pref file.
• Use Apple DocViewer’s “Copy” command to get code samples and paste them into your source. This code can them be compiled or incorporated into your software. Remember, there is no copyright limitation on use of source code from Apple documentation.
• Technical writers developing in-house documentation can use Apple DocViewer’s “Copy” capability to grab figures or text from Apple documentation for internal documentation or in-house training. Unlike source code, however, documentation or courses developed for sale to your customers MAY NOT incorporate figures or text from Apple documentation.
Recommendations, Tips, and Techniques (continued)
• Apple DocViewer’s “Bind Document” command provides many features for simplifying use:
- Bound documents always appear in the Catalog window.
- The “Query” command can search bound documents even if they are not open.
- They can be automatically be found over servers on the network.
- When you quit Apple DocViewer, open bound documents are reopened the next time you open the application.
- Bookmarks can be added to Bound documents.
• We have tried to optimize the usability of Apple DocViewer on small screens. If you have a small screen, we recommend you use the the “Text Only” view of Apple DocViewer, and adjust the window size to your liking. Then use the page up/down arrow icons to navigate individual pages in the document.
Known Problems
• Problem: Running UniFinder on System 6.0.5 on a Macintosh SE, the Apple DocViewer crashes when the Control Panel is accessed.
Solution: Run the Apple DocViewer in MutiFinder or do not access Control Panel while the Apple DocViewer is running.
• Problem: On a PowerBook 100, the New Inside Macintosh documents do not display the contents of the title page when first opened.
Solution: Navigate to another page and then come back to the first page, the title page.
• Problem: When printing New Inside Macintosh documents, the top and bottom edges of the page can be cut off.
Solution: Set the “Larger Print Area” option available from the LaserWriter’s “Page Setup/Options” dialogue.
• Problem: The “From” and “To” fields in the “Print” dialog box do not accept the
“Chapter-Page” form of page numbers (e.g., From 1-3 to 3-3).
Solution: Use the physical page numbers displayed inside the parentheses in the “Page Indicator” area of the document window. Lower portion of the Print Dialog will display the actual page numbers displayed on the document.
• Problem: There is no change in the document when a change is made to the “Preferences” (e.g., if “Continuous” is set as the default display view).
Solution: Changes in “Preferences” apply only to subsequent documents as they are opened.
• Problem: “Query ‘Within n words of…’” does not count the number of words correctly, given an integer value for n.
Solution: Add 2 to 3 for the value n.
• Problem: When you use “Query”, Apple DocViewer displays the message “The index file for <<docname>> cannot be found.”
Solution: Be sure the Apple DocViewer document and its associated “.idx” file are in the same folder
• Problem: Some “Query” searches do not find text that includes punctuation or hyphens in either the search string or the text being searched.
Solution: There is a bug in the “Query” command such that punctuation characters are not passed to the search engine. For example, the search string “get file” will not find the text “get, file” – the fix (for now) is to search for “get x file”. The “x” serves as a noise word that is ignored, but broadens the search. Searching “get x file” will find “get file”, “get, file”, “get on file”, “get the file”, etc.
B ◊# ˇ ˇˇˇˇ # ◊
d , Geneva
. ° d ONLN d ø .h +›HApple DocViewer
° d ONLN d - fi @I +
• Read Me •
° d ONLN d D T7 + Version 1.0
° d ONLN d * e x ( í 6 What is the Apple DocViewer?
° d ONLN d G w Ñ i *Apple DocViewer ° d ONLN d V w i ÑÊ )QP is an online documentation application. It provides a standard way for Apple to ° d ONLN d ß É êA ( ¨ 6=distribute documentation to developers in an electronic form. ° d ONLN d  õ ® i *Apple DocViewer ° d ONLN d Ù õ i ®˝ )QQ provides a quick on-screen reference for browsing through multiple documents. It ° d ONLN dF ß ¥ ( – 6fsupports full Macintosh mixed-text and graphics, printing, interactive table of contents/catalog, book ° d ONLN d≠ ≥ ¿
* iindexes, text search & retrieval, the ability to copy text and/or pictures for use in other applications, ° d ONLN d ø Ã≠ * Rand provides the ability to set bookmarks to commonly used pages in documentation.
_Dynamic text reformatting in Text View: When you change the window size in Text View, the text ° d ONLN då 7 ê * Eautomatically rewraps in the window according to the new window size. ° d ONLN d“# *0 1 (L H- ° d ONLN d‘# 70 Ê )
%Personal style sheet for Text View: ° d ONLN d˘# Ê0: )ØApple DocViewer ° d ONLN d #:0‚ )T#lets you change font/style/size for ° d ONLN d-/ 7<6 (X U4Chapter/Section headings and body text in Text View. ° d ONLN db@ *M 1 (i H- ° d ONLN dd@ 7M Ω )
More intuitive Print Dialog ° d ONLN dÄQ *^ 1 (z H- ° d ONLN dÇQ 7^ ‹ )
!Even/Odd page printing capability ° d ONLN d§b *o 1 (ã H- ° d ONLN d¶b 7o )
/Arrow keys for navigation and selection in text ° d ONLN d÷s *Ä 1 (ú H- ° d ONLN dÿs 7Ä Ê )
!Improved memory usage via caching ° d ONLN d˙Ñ *ë 1 (≠ H- ° d ONLN d¸Ñ 7ë ¿ )
Balloon help for menu items ° d ONLN dï *¢ 1 (æ H- ° d ONLN dï 7¢ ¸ )
$Remembering “Page Setup” information ° d ONLN d?¶ *≥ 1 (œ H- ° d ONLN dA¶ 7≥ Ê )
Removal of low-memory crash bugs ° d ONLN db∑ *ƒ 1 (‡ H- ° d ONLN dd∑ 7ƒ” )
PConsistent error messages and disabling of commands during low-memory conditions ° d ONLN dµœ ‹ (¯ 6bThere are some minor bugs and enhancements which are not addressed in Version 1.0. These and user ° d ONLN d€ Ë * ftips are documented in later pages of this Read Me file. If you have comments or suggestions we would ° d ONLN dÁ Ù * glike to hear from you via AppleLink to DEV.CD. We will not be answering individual questions about this ° d ONLN dÁÛ Å * Jsoftware, but this information will be forwarded to the engineering group.
° d ONLN d2 w * Installation
° d ONLN d? * i *Apple DocViewer ° d ONLN dN i* )QQ runs on all models of the Macintosh® computer from the Macintosh Plus onward. It ° d ONLN d†) 6 (R 6druns under versions 6.0.5 and later of the Macintosh system software, including version 7.0, Release ° d ONLN d5 B / * 7.1. ° d ONLN d
+≠@ Apple DocViewer v1.0 Read Me (ÚPage )1 ˇ» ◊# ˇ ˇˇˇˇ # ◊
d , Geneva
. ° d ONLN d * v +6D Limitations
° d ONLN d ) 6 i *Apple DocViewer ° d ONLN d ) i 6Ú )QP is NOT a word processor—it was designed to support quick conversion of existing ° d ONLN d l 5 B ⁄ ( ^ 6(technical documents to electronic form. ° d ONLN d î 5 ⁄ B+ )¬Apple DocViewer ° d ONLN d £ 5+ B )Q- focuses on being both a printing and display ° d ONLN d — A N û ( j 6 tool. Printing is limited by ° d ONLN d Ó A û N Ô )ÜApple DocViewer ° d ONLN d ˝ A Ô NÊ )Q5’s display capabilities and displaying is limited by ° d ONLN d2 AÊ N )˜Apple ° d ONLN d8 M Z K ( v 6 DocViewer ° d ONLN dA M K Z ˆ )3%’s print capabilities. In particular: ° d ONLN dg ^ * k 1 ( á H- ° d ONLN di ^ 7 k )
\Display spacing may appear uneven on some documents because the text is kerned for printing, ° d ONLN dΔ j 7 w o * not display. ° d ONLN d” { * à 1 ( § H- ° d ONLN d’ { 7 àZ )
;Output on non-postscript printers may be less satisfactory. ° d ONLN d å * ô 1 ( µ H- ° d ONLN d å 7 ôÑ )
DColor/Gray Scale must be selected for printing color/shaded figures. ° d ONLN dX ù * ™ 1 ( Δ H- ° d ONLN dZ ù 7 ™ )
ZThe “Text Only” view is only partially implemented. Text still needs to continuously flow ° d ONLN dï fi 7 Îö * Hbetween page boundaries for true dynamic text reformatting capabilities. ° d ONLN dfi Ô * ¸ 1 ( H- ° d ONLN d‡ Ô 7 ¸ )
*Printing from the Finder is not supported.
° d ONLN d _ (0 6%Recommendations, Tips, and Techniques
° d ONLN d1 " *• ° d ONLN d3 %"¸ )
dIt is not required, but use both bitmap and TrueType fonts for the best display quality . If you are ° d ONLN dò! %.P * <running under System 6, please use the TrueType INIT in the ° d ONLN d‘!P.‘ (JnTrueType Fonts & Software ° d ONLN dÌ!‘.˙ )Ñ folder. ° d ONLN d˜2 ? ([ 6• ° d ONLN d˘2 %? )
dTo improve display legibility on monitors larger than 13'' (that typically have a resolution greater ° d ONLN d^> %K” * Vthen 72 dpi) set SCALING to 112% in the document window. We've found this to be a good ° d ONLN dµJ %W * -compromise between window size and font size. ° d ONLN d„[ h (Ñ 6• ° d ONLN dÂ[ %h v )
Apple DocViewer ° d ONLN dÙ[ vh )QR has been optimized for displaying documents off of a CD-ROM or AppleShare server. ° d ONLN dGg %t˛ (ê CbHowever, copying the document file you use most (and its associated index file) to your local hard ° d ONLN d™s %Ä ˝ * +disk can significantly improve performance. ° d ONLN d÷Ñ ë (≠ 6• ° d ONLN dÿÑ %ë^ )
Apple DocViewer ° d ONLN dΔ≈ v“ )QQ is optimized for printing on Postscript printers, such as the Apple LaserWriter. ° d ONLN d — %fi ç (˙ CNew Inside Macintosh ° d ONLN d ,— çfiˇ )hK documents take advantage of the “Larger Print Area” option available from ° d ONLN d x› %Í ( C`the LaserWriter’s Page Setup/Options dialogue. Printing with other printers will work, but there ° d ONLN d ŸÈ %ˆ * /may be clipped pages, or reduced print quality. ° d ONLN d
˙ (# 6• ° d ONLN d
˙ % )
0Users in countries which use A4 paper may print ° d ONLN d
;˙i )ÛApple DocViewer ° d ONLN d
J˙i )Q documents by using the “Reduce ° d ONLN d
j % (/ C/or Enlarge” setting of the “Page Setup” dialog. ° d ONLN d
ö $ (@ 6• ° d ONLN d
ú %$ v )
Apple DocViewer ° d ONLN d
´ v$˙ )QQ does not provide the functionality to modify any document; instead it saves your ° d ONLN d
Use ° d ONLN d ≠@ 9M ä )Apple DocViewer ° d ONLN d º@ äM )QK’s “Copy” command to get code samples and paste them into your source. This ° d ONLN d L %Yˆ (u C]code can them be compiled or incorporated into your software. Remember, there is no copyright ° d ONLN d fX %eA * :limitation on use of source code from Apple documentation. ° d ONLN d °i v (í 6• ° d ONLN d £i %vR )
<Technical writers developing in-house documentation can use ° d ONLN d fliRv£ (ípApple DocViewer ° d ONLN d Ói£v )Q’s “Copy” capability ° d ONLN d
u %Ç (û Cato grab figures or text from Apple documentation for internal documentation or in-house training. ° d ONLN d
eÅ %é˝ * ^Unlike source code, however, documentation or courses developed for sale to your customers MAY ° d ONLN d
ƒç %öB * 9NOT incorporate figures or text from Apple documentation.
+†< Apple DocViewer v1.0 Read Me (ÚPage )2 ˇÏ ◊# ˇ ˇˇˇˇ # ◊
d , Geneva
. ° d ONLN d *d +6D&Recommendations, Tips, and Techniques ° d ONLN d & d *∑ ( DÇ (continued)
° d ONLN d 2 ) 6 ( R 6• ° d ONLN d 4 ) % 6 v )
Apple DocViewer ° d ONLN d C ) v 6‡ )QF’s “Bind Document” command provides many features for simplifying use: ° d ONLN d ä : * G 1 ( c H- ° d ONLN d å : 7 G? )
4Bound documents always appear in the Catalog window. ° d ONLN d ¡ K * X 1 ( t H- ° d ONLN d √ K 7 X¨ )
IThe “Query” command can search bound documents even if they are not open. ° d ONLN d
\ * i 1 ( Ö H- ° d ONLN d \ 7 io )
?They can be automatically be found over servers on the network. ° d ONLN dO m * z 1 ( ñ H- ° d ONLN dQ m 7 z )
When you quit ° d ONLN d_ m z – )HApple DocViewer ° d ONLN dn m – z )Q>, open bound documents are reopened the next time you open the ° d ONLN d≠ y 7 Ü p ( ¢ U application. ° d ONLN d∫ ä * ó 1 ( ≥ H- ° d ONLN dº ä 7 ó )
*Bookmarks can be added to Bound documents. ° d ONLN dÁ õ ® ( ƒ 6• ° d ONLN dÈ õ % ® Ò )
+We have tried to optimize the usability of ° d ONLN d õ Ò ®B )ÃApple DocViewer ° d ONLN d# õB ®˜ )Q& on small screens. If you have a small ° d ONLN dJ ß % ¥F ( – C9screen, we recommend you use the the “Text Only” view of ° d ONLN dÉ ßF ¥ó ( –dApple DocViewer ° d ONLN dí ßó ¥ )Q, and adjust the window ° d ONLN d™ ≥ % ¿È ( ‹ C^size to your liking. Then use the page up/down arrow icons to navigate individual pages in the ° d ONLN d ø % à U * document.
° d ONLN d ” Ê ú ( 6Known Problems
° d ONLN d" Â Ú *• ° d ONLN d$ Â % Ú O )
Problem ° d ONLN d+ Â O Ú R )*: ° d ONLN d- Â [ Ú{ ) 9Running UniFinder on System 6.0.5 on a Macintosh SE, the ° d ONLN df Â{ ÚÃ (ôApple DocViewer ° d ONLN du ÂÃ Ú )Q
crashes when ° d ONLN dÉ Ú [ ˇ È ( y the Control Panel is accessed. ° d ONLN d£ ˛ % P (' C Solution: ° d ONLN d≠ ˛ [ É )6Run the ° d ONLN dµ ˛ É ‘ )(Apple DocViewer ° d ONLN dƒ ˛ ‘ · )Q8 in MutiFinder or do not access Control Panel while the ° d ONLN d¸ ˛· ¸ ('ˇApple ° d ONLN d
[ é (3 y DocViewer ° d ONLN d
é « )3 is running. ° d ONLN d + (G 6• ° d ONLN d %+ O )
Problem ° d ONLN d! O+ R )*: ° d ONLN d# [+ Ÿ ) On a PowerBook 100, the ° d ONLN d; Ÿ+A )~New Inside Macintosh ° d ONLN dO A+ )h) documents do not display the contents of ° d ONLN dy+ [8 ˆ (T y!the title page when first opened. ° d ONLN dú7 %D P (` C Solution: ° d ONLN d¶7 [D» )6NNavigate to another page and then come back to the first page, the title page. ° d ONLN dıK X (t 6• ° d ONLN d˜K %X O )
Problem ° d ONLN d˛K OX R )*: ° d ONLN d K [X • ) When printing ° d ONLN dK •X
)JNew Inside Macintosh ° d ONLN d"K
X )h4 documents, the top and bottom edges of the page can ° d ONLN dWX [e ã (Å y be cut off. ° d ONLN ddd %q P (ç C Solution: ° d ONLN dnd [qà )6ISet the “Larger Print Area” option available from the LaserWriter’s “Page ° d ONLN d∏p [} ‘ * Setup/Options” dialogue. ° d ONLN d“Ñ ë (≠ 6• ° d ONLN d‘Ñ %ë O )
Problem ° d ONLN d€Ñ Oë R )*: ° d ONLN d›Ñ [ë¥ ) FThe “From” and “To” fields in the “Print” dialog box do not accept the ° d ONLN d%ë [ûò *
Problem ° d ONLN dM… O÷ R )*: ° d ONLN dO… [÷ ) WThere is no change in the document when a change is made to the “Preferences” (e.g., if ° d ONLN dß÷ [„G *
1“Continuous” is set as the default display view). ° d ONLN d⁄‚ %Ô P ( C Solution: ° d ONLN d‰‚ [ÔÁ )6OChanges in “Preferences” apply only to subsequent documents as they are opened. ° d ONLN d4ˆ ( 6• ° d ONLN d6ˆ % O )
Problem ° d ONLN dÿ# O0 R )*: ° d ONLN d⁄# [0 “ ) When you use “Query”, ° d ONLN d# “0# )wApple DocViewer ° d ONLN dˇ##0Ë )Q) displays the message “The index file for ° d ONLN d )0 [= Ó (Y y <<docname>> cannot be found.” ° d ONLN d H< %I P (e C Solution: ° d ONLN d R< [I ï )6 Be sure the ° d ONLN d ^< ïI Ê ):Apple DocViewer ° d ONLN d m< ÊI )Q? document and its associated “.idx” file are in the same folder ° d ONLN d ≠P ] (y 6• ° d ONLN d ØP %] O )
Problem ° d ONLN d ∂P O] R )*: ° d ONLN d ∏P [] ) YSome “Query” searches do not find text that includes punctuation or hyphens in either the ° d ONLN d
] [j *
)search string or the text being searched. ° d ONLN d
=i %v P (í C Solution: ° d ONLN d
Gi [v )6XThere is a bug in the “Query” command such that punctuation characters are not passed to ° d ONLN d
†u [Ç * Ythe search engine. For example, the search string “get file” will not find the text “get, ° d ONLN d
˙Å [é * \file” – the fix (for now) is to search for “get x file”. The “x” serves as a noise word that ° d ONLN d Wç [ö˜ * Wis ignored, but broadens the search. Searching “get x file” will find “get file”, “get, ° d ONLN d Øô [¶ * *file”, “get on file”, “get the file”, etc.
